Skip to content

Clarify list_add documentation #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 5, 2025
Merged

Clarify list_add documentation #225

merged 1 commit into from
Mar 5, 2025

Conversation

SimonLiu423
Copy link
Contributor

Originally, the function list_add is said to insert a node at the beginning of a given list.
However, it could also be used to insert a node after any existing node in the list.

Therefore, this pr modifies its documentation to reflect the actual list manipulation performed by the function.

jserv

This comment was marked as resolved.

Sign in to view

@SimonLiu423 SimonLiu423 force-pushed the docs/clarify-list-add branch 2 times, most recently from 276d4f0 to ec73a7e Compare March 4, 2025 07:04
@SimonLiu423 SimonLiu423 closed this Mar 4, 2025
@SimonLiu423 SimonLiu423 force-pushed the docs/clarify-list-add branch from ec73a7e to 474f638 Compare March 4, 2025 07:07
@SimonLiu423 SimonLiu423 mentioned this pull request Mar 4, 2025
Closed
@jserv
Copy link
Contributor

jserv commented Mar 4, 2025

Why did you close this pull request?

@jserv jserv reopened this Mar 4, 2025
@SimonLiu423
Copy link
Contributor Author

I intended to sync my branch with the master branch on Github, but it then removes my commit and closed this pr automatically.

@jserv
Copy link
Contributor

jserv commented Mar 4, 2025

I intended to sync my branch with the master branch on Github, but it then removes my commit and closed this pr automatically.

Use git rebase -i to rework your commits. Then, do git push --force.

@SimonLiu423
Copy link
Contributor Author

I intended to sync my branch with the master branch on Github, but it then removes my commit and closed this pr automatically.

Use git rebase -i to rework your commits. Then, do git push --force.

I've reworked my commits already, please review. 😄

@jserv
Copy link
Contributor

jserv commented Mar 5, 2025

I've reworked my commits already, please review. 😄

You don't have to leave the message for reviewing. Instead, check Requesting a pull request review:

  • request a review from a suggested person under Reviewers
  • Navigate to Reviewers in the right sidebar and click next to the reviewer's name whose review you'd like

jserv
jserv requested changes Mar 5, 2025
View reviewed changes
Copy link
Contributor

@jserv jserv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drop the statement "The checksum of list.h is also updated." to emphasize on the documentation revision.

@SimonLiu423
Clarify list_add documentation
13d8a6f 
Originally, the function list_add is said to insert a node at the
beginning of a given list. However, it could also be used to insert a
node after any existing node in the list. Therefore, this commit
modifies its documentation to reflect the actual list manipulation
performed by the function.

Change-Id: I661d7a0ebb876712c8ff75deef84370a51e62f1c
@SimonLiu423 SimonLiu423 force-pushed the docs/clarify-list-add branch from 415828f to 13d8a6f Compare March 5, 2025 03:09
@SimonLiu423 SimonLiu423 requested a review from jserv March 5, 2025 03:11
@SimonLiu423
Copy link
Contributor Author

I've reworked my commits already, please review. 😄

You don't have to leave the message for reviewing. Instead, check Requesting a pull request review:

  • request a review from a suggested person under Reviewers
  • Navigate to Reviewers in the right sidebar and click next to the reviewer's name whose review you'd like

Got it, thanks!

@jserv jserv merged commit 29d90ea into sysprog21:master Mar 5, 2025
1 of 2 checks passed
@jserv
Copy link
Contributor

jserv commented Mar 5, 2025

Thank @SimonLiu423 for contributing!

@SimonLiu423 SimonLiu423 deleted the docs/clarify-list-add branch March 5, 2025 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jserv jserv Awaiting requested review from jserv

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SimonLiu423 @jserv